<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SoupCookieJarText</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="libsoup Reference Manual">
<link rel="up" href="ch03.html" title="Additional Features">
<link rel="prev" href="SoupCookieJar.html" title="SoupCookieJar">
<link rel="next" href="SoupLogger.html" title="SoupLogger">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="SoupCookieJar.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libsoup Reference Manual</th>
<td><a accesskey="n" href="SoupLogger.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#SoupCookieJarText.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#SoupCookieJarText.description" class="shortcut">Description</a>
                   | 
                  <a href="#SoupCookieJarText.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#SoupCookieJarText.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                   | 
                  <a href="#SoupCookieJarText.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="SoupCookieJarText"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="SoupCookieJarText.top_of_page"></a>SoupCookieJarText</span></h2>
<p>SoupCookieJarText — Text-file-based ("cookies.txt") Cookie Jar</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="SoupCookieJarText.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;libsoup/soup.h&gt;

                    <a class="link" href="SoupCookieJarText.html#SoupCookieJarText-struct" title="SoupCookieJarText">SoupCookieJarText</a>;
<a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="returnvalue">SoupCookieJar</span></a> *     <a class="link" href="SoupCookieJarText.html#soup-cookie-jar-text-new" title="soup_cookie_jar_text_new ()">soup_cookie_jar_text_new</a>            (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> read_only</code></em>);

#define             <a class="link" href="SoupCookieJarText.html#SOUP-COOKIE-JAR-TEXT-FILENAME:CAPS" title="SOUP_COOKIE_JAR_TEXT_FILENAME">SOUP_COOKIE_JAR_TEXT_FILENAME</a>
</pre>
</div>
<div class="refsect1">
<a name="SoupCookieJarText.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----<a class="link" href="SoupCookieJar.html" title="SoupCookieJar">SoupCookieJar</a>
         +----SoupCookieJarText
</pre>
</div>
<div class="refsect1">
<a name="SoupCookieJarText.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
SoupCookieJarText implements
 <a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature">SoupSessionFeature</a>.</p>
</div>
<div class="refsect1">
<a name="SoupCookieJarText.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="SoupCookieJarText.html#SoupCookieJarText--filename" title='The "filename" property'>filename</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1">
<a name="SoupCookieJarText.description"></a><h2>Description</h2>
<p>
<a class="link" href="SoupCookieJarText.html" title="SoupCookieJarText"><span class="type">SoupCookieJarText</span></a> is a <a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a> that reads cookies from and
writes them to a text file in the Mozilla "cookies.txt" format.
</p>
</div>
<div class="refsect1">
<a name="SoupCookieJarText.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="SoupCookieJarText-struct"></a><h3>SoupCookieJarText</h3>
<pre class="programlisting">typedef struct _SoupCookieJarText SoupCookieJarText;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="soup-cookie-jar-text-new"></a><h3>soup_cookie_jar_text_new ()</h3>
<pre class="programlisting"><a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="returnvalue">SoupCookieJar</span></a> *     soup_cookie_jar_text_new            (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> read_only</code></em>);</pre>
<p>
Creates a <a class="link" href="SoupCookieJarText.html" title="SoupCookieJarText"><span class="type">SoupCookieJarText</span></a>.
</p>
<p>
<em class="parameter"><code>filename</code></em> will be read in at startup to create an initial set of
cookies. If <em class="parameter"><code>read_only</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, then the non-session cookies will
be written to <em class="parameter"><code>filename</code></em> when the 'changed' signal is emitted from
the jar. (If <em class="parameter"><code>read_only</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, then the cookie jar will only be
used for this session, and changes made to it will be lost when the
jar is destroyed.)
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>the filename to read to/write from</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>read_only</code></em> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>filename</code></em> is read-only</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the new <a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.26</p>
</div>
<hr>
<div class="refsect2">
<a name="SOUP-COOKIE-JAR-TEXT-FILENAME:CAPS"></a><h3>SOUP_COOKIE_JAR_TEXT_FILENAME</h3>
<pre class="programlisting">#define SOUP_COOKIE_JAR_TEXT_FILENAME  "filename"
</pre>
<p>
Alias for the <a class="link" href="SoupCookieJarText.html#SoupCookieJarText--filename" title='The "filename" property'><span class="type">"filename"</span></a> property. (The
cookie-storage filename.)
</p>
</div>
</div>
<div class="refsect1">
<a name="SoupCookieJarText.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="SoupCookieJarText--filename"></a><h3>The <code class="literal">"filename"</code> property</h3>
<pre class="programlisting">  "filename"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
<p>Cookie-storage filename.</p>
<p>Default value: NULL</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>